Work Request Manager API
Exception Handling
The table below describes exception responses received from the WRM API.
Response messages are system generated and include the following information:
- the object that failed validation
- the reason for the validation failure, i.e. additionalProperties, type, missing, anyOf, enum
- failure message
- attributes that have failed validation
| Response Code | Use Case | Type | Recipient | Response description |
|---|---|---|---|---|
| 01013 | Create Field Work Request | Response - exception | Work Requestor | An active field work request already exists for task type <task type>, work type <work type> and product instance <product.instanceId>. Unable to create work request. |
| 01014 | Create Field Work Request | Response - exception | Work Requestor | Schedule ID must be supplied with appointment date. Unable to create field work request. |
| 01015 | Create Field Work Request | Response - exception | Work Requestor | Invalid campaign ID or schedule ID provided. Unable to create field work request. |
| 01016 | Create Field Work Request | Response - exception | Work Requestor | Invalid allocation parameters supplied with related activities. Unable to create field work request. |
| 01017 | Create Field Work Request | Response - exception | Work Requestor | Invalid request provided. Unable to create field work request. |
| 01018 | Create Field Work Request | Response - exception | Work Requestor | Invalid schedule ID provided. Unable to create field work request. |
| 010120 | Create Field Work Request | Response (when both earliestStart and latestEnd are supplied or when neither earliestStart or latestEnd are supplied) | Work Requestor | The schedule details are invalid. Unable to process this request. |
| 010120 | Create Field Work Request | Response (LocationId for site not supplied for FibreConnect or REMO work type) | Work Requestor | At least one location ID of type TLC must be supplied for the site for <workType>. Unable to process this request. |
| 010120 | Create Field Work Request | Response (when contact name or contact first and last name not supplied) | Work Requestor | The contact name or both the first name and last name of the contact must be supplied. Unable to process this request. |
| 010121 | Create Field Work Request | Response (escalationNote not supplied for escalation = 'True') | Work Requestor | Escalation note must be supplied when escalation is true. Unable to process this request. |
| 010220 | Create Field Work Request | Response (Fibre Availability for site detail not supplied for FibreConnect or REMO work type) | Work Requestor | The fibre availability indicator of the activity's site detail must be supplied for <workType>. Unable to process this request. |
| 02051 | Update Field Work Request | Response - exception | Work Requestor | The response message is system generated and includes the following information: - the object that failed validation - the reason for the validation failure i.e. additionalProperties, type, missing, anyOf, enum failure message - attributes that have failed validation. |
| 02054 | Update Field Work Request | Response - exception | Work Requestor | Update not allowed on closed/cancelled work request. |
| 02056 | Update Field Work Request | Response - exception | Work Requestor | Field work request supplied does not exist. Unable to update work request. |
| 02057 | Update Field Work Request | Response - exception | Work Requestor | Permission to update the field work request supplied denied. Unable to update work request. |
| 020520 | Update Field Work Request | Response (when contact name or contact first and last name not supplied) | Work Requestor | The contact name or both the first name and last name of the contact must be supplied. Unable to process this request. |
| 020521 | Update Field Work Request | Response (escalationNote not supplied for escalation = 'True') | Work Requestor | Escalation note must be supplied when escalation is true. Unable to process this request. |
| 01061 | Accept Field Work Request | Response - exception | Work Supplier | The response message is system generated and includes the following information: - the object that failed validation - the reason for the validation failure, i.e. additionalProperties, type, missing, anyOf, enum - failure message - attributes that have failed validation. |
| 01062 | Accept Field Work Request | Response - exception | Work Supplier | Task <taskId> does not exist and cannot be accepted. |
| 01063 | Accept Field Work Request | Response - exception | Work Supplier | Acceptance against Work Request <taskId> is not expected. The Work Request is in <current state>. |
| 01064 | Accept Field Work Request | Response - exception | Work Supplier | This Work Request <taskId> is not currently allocated to you and the notification is discarded. |
| 01072 | Reject Field Work Request | Response - exception | Work Supplier | Work request <taskId> does not exist and cannot be rejected. |
| 01073 | Reject Field Work Request | Response - exception | Work Supplier | Rejection against Work Request <taskId> is not expected as work on the underlying activities as already progress. The Work Request is in <current state>. |
| 01074 | Reject Field Work Request | Response - exception | Work Supplier | Rejection against Work Request <taskId> is not expected. The Work Request is in <current state>. |
| 01075 | Reject Field Work Request | Response - exception | Work Supplier | This Work Request <taskId> is not currently allocated to you and the notification is discarded. |
| 01076 | Reject Field Work Request | Response - exception | Work Supplier | Reject reason is not valid. Rejection of Work request is not completed. |
| 02093 | Cancel Field Work Request | Response - exception | Work Requestor | Field work request supplied does not exist. Unable to update field work request. |
| 02094 | Cancel Field Work Request | Response - exception | Work Requestor | Update not allowed on closed/cancelled work request. |
| 02095 | Cancel Field Work Request | Response - exception | Work Requestor | Permission to update the field work request supplied denied. Unable to update work request. |
| 02083 | Put Field Work Request On Hold | Response - exception | Work Requestor | Field work request supplied does not exist. Unable to update field work request. |
| 02084 | Put Field Work Request On Hold | Response - exception | Work Requestor | Update not allowed on closed/cancelled field work request. |
| 02085 | Put Field Work Request On Hold | Response - exception | Work Requestor | Permission to update the field work request supplied denied. Unable to update field work request. |
| 02042 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unavailable at this time. Try again later, or contact IT support team to investigate the issue. |
| 02043 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | Supplied TaskId does not exist. |
| 02044 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unable to share this information because requester does not have rights to GET this taskId. |
| 02045 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unable to share this information because requester does not have rights to GET this taskId. |
| 02046 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | Supplied ActivityId does not exist. |
| 02047 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unable to share this information because requester does not have rights to GET this activity. |
| 02048 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unable to share this information because requester does not have rights to GET this activity. |
| 010220 | Create Activity | Response (LocationId for site not supplied for FibreConnect or REMO work type) | Work Requestor | At least one location ID of type TLC must be supplied for the site for <workType>. Unable to process this request. |
| 010220 | Create Activity | Response (Fibre Availability for site detail not supplied for FibreConnect or REMO work type) | Work Requestor | The fibre availability indicator of the activity's site detail must be supplied for <workType>. Unable to process this request. |
| 010220 | Create Activity | Response (when contact name or contact first and last name not supplied) | Work Requestor | The contact name or both the first name and last name of the contact must be supplied. Unable to process this request. |
| 03034 | Update Activity | Response - exception | Work Requestor or Work Supplier | Update not allowed on activity, field work request closed. |
| 03035 | Update Activity | Response - exception | Work Requestor or Work Supplier | Field work request supplied does not exist. Unable to update activity. |
| 03036 | Update Activity | Response - exception | Work Requestor or Work Supplier | Permission to update the activity supplied denied. Unable to update activity. |
| 03037 | Update Activity | Response - exception | Work Requestor or Work Supplier | Permission to update the activity supplied denied. Unable to update activity. |
| 03038 | Update Activity | Response - exception | Work Requestor or Work Supplier | Activity supplied does not exist. Unable to update activity. |
| 03039 | Update Activity | Response - exception | Work Requestor | Permission to update the activity status not allowed. Unable to update activity. |
| 030310 | Update Activity | Response - exception | Work Supplier | Activity category or state supplied does not exist. Unable to update activity. |
| 030311 | Update Activity | Response - exception | Work Supplier | Activity category or state transition not allowed. Unable to update activity. |
| 030312 | Update Activity | Response - exception | Work Supplier | Invalid reason code. Unable to update activity. |
| 030313 | Update Activity | Response - exception | Work Supplier | Activity category or state transition not allowed from <category-state> to <category-state>. Unable to update activity. |
| 030314 | Update Activity | Response - exception | Work Supplier | Update not allowed on closed activity. Unable to update activity. |
| 030320 | Update Activity | Response (when contact name or contact first and last name not supplied) | Work Requestor or Work Supplier | The contact name or both the first name and last name of the contact must be supplied. Unable to process this request. |
| 0303201 | Update Activity | Response (when schedule rescheduleReason not supplied and appointment date or scheduled start or end date has changed) | Work Supplier | The reschedule reason and note must be supplied. Unable to process this request. |
| 030321 | Update Activity | Response | Work Supplier | Geotag must be supplied when the state of the activity is set to 'OnSite'. Unable to update activity. |
| 030322 | Update Activity | Response (when schedule rescheduleReason not supplied and appointment date or scheduled start or end date has changed) | Work Supplier | The next action owner must be supplied. Unable to process this request. |
| 030323 | Update Activity | Response (when schedule rescheduleReason not supplied and appointment date or scheduled start or end date has changed) | Work Supplier | The reschedule note must be supplied. Unable to process this request. |
| 02073 | Add Activity | Response - exception | Work Requestor | Add activity not allowed on closed/cancelled work request. |
| 02074 | Add Activity | Response - exception | Work Requestor | Field work request supplied does not exist. Unable to add activity. |
| 02075 | Add Activity | Response - exception | Work Requestor | Permission to add an activity to the field work request denied. Unable to add an activity. |
| 02076 | Add Activity | Response (schedule ID is not provided for the activity) | Work Requestor | Schedule ID must be supplied with appointment date. Unable to add activity. |
| 020720 | Add Activity | Response (when contact name or contact first & last name not supplied) | Work Requestor | The contact name or both the first name and last name of the contact must be supplied. Unable to process this request. |
| 020720 | Add Activity | Response (LocationId for site not supplied for FibreConnect or REMO work type) | Work Requestor or Work Supplier | At least one location ID of type TLC must be supplied for the site for <workType>. Unable to process this request. |
| 020720 | Add Activity | Response (Fibre Availability for site detail not supplied for FibreConnect or REMO work type) | Work Requestor | The fibre availability indicator of the activity's site detail must be supplied for <workType>. Unable to process this request. |
| 04041 | Authorise Activity Request | Response | Work Supplier | Activity type not allowed for activity request authorisation. Unable to add activity. |
| 03053 | Put Activity On Hold | Response - exception | Work Supplier | Update not allowed on closed activity. |
| 03054 | Put Activity On Hold | Response - exception | Work Supplier | Field work request supplied does not exist. Unable to update activity. |
| 03055 | Put Activity On Hold | Response - exception | Work Supplier | Activity supplied does not exist. Unable to update activity. |
| 03056 | Put Activity On Hold | Response - exception | Work Supplier | Permission to update the activity supplied denied. Unable to update activity. |
| 03057 | Put Activity On Hold | Response - exception | Work Supplier | Unexpected error occurred, Chorus operations investigating. Unable to update activity. |
| 03058 | Put Activity On Hold | Response - exception | Work Supplier | Invalid reason code. Unable to update activity. |
| 03059 | Put Activity On Hold | Response - exception | Work Supplier | Activity category or state transition not allowed from <category-state> to <category-state>. Unable to update activity. |
| 030510 | Put Activity On Hold | Response - exception | Work Supplier | Update not allowed on closed activity. Unable to update activity. |
| 03063 | Close Activity | Response - exception | Work Supplier | Update not allowed on closed activity. Unable to close activity. |
| 03064 | Close Activity | Response - exception | Work Supplier | Update not allowed on activity. Unable to close activity. |
| 03065 | Close Activity | Response - exception | Work Supplier | Activity category or state transition not allowed from <category-state> to <category-state>. Unable to update activity. |
| 03066 | Close Activity | Response - exception (when work supplier closes activity and trouble found code not supplied for 'REMO', 'REMI', 'REMS') | Work Supplier | Trouble Found Code not supplied. Unable to update activity. |
| 03073 | Request Cancel Activity | Response - exception | Work Requestor | Update not allowed on closed activity. |
| 03074 | Request Cancel Activity | Response - exception | Work Requestor | Not allowed for closed activity. |
| 03075 | Request Cancel Activity | Response - exception | Work Requestor | Permission to request cancel denied. Unable to request cancellation of activity. |
| 03076 | Request Cancel Activity | Response - exception | Work Requestor | Appointment has not been cancelled. Cancel request not allowed. |
| 03077 | Request Cancel Activity | Response - exception | Work Requestor | Activity supplied does not exist. Unable to request cancellation of activity. |
| 04013 | Request Add Activity | Response - exception | Work Supplier | Add activity request not allowed on closed/cancelled work request. |
| 04014 | Request Add Activity | Response - exception | Work Supplier | Field work request supplied does not exist. Unable to add activity request. |
| 04015 | Request Add Activity | Response - exception | Work Supplier | Permission to add an activity request to the field work request denied. Unable to add an activity request. |
| 040120 | Request Add Activity | Response (when contact name or contact first and last name not supplied) | Work Requestor or Work Supplier | The contact name or both the first name and last name of the contact must be supplied. Unable to process this request. |
| 040120 | Request Add Activity | Response (Fibre Availability for site detail not supplied for FibreConnect or REMO work type) | Work Requestor or Work Supplier | The fibre availability indicator of the activity's site detail must be supplied for <workType>. Unable to process this request. |
| 040120 | Request Add Activity | Response (LocationId for site not supplied for FibreConnect or REMO work type) | Work Requestor or Work Supplier | At least one location ID of type TLC must be supplied for the site for <workType>. Unable to process this request. |
| 02013 | Request and Provide Additional Information | Response - exception | Work Requestor or Work Supplier | Unable to process this request Work Request does not exist. |
| 02014 | Request and Provide Additional Information | Response - exception | Work Requestor or Work Supplier | Unable to process this request. Activity Work Request does not exist. |
| 02015 | Request and Provide Additional Information | Response - exception | Work Requestor or Work Supplier | Unable to process this request. Work Request is not allocated to a Work Supplier. |
| 02016 | Request and Provide Additional Information | Response - exception | Work Requestor or Work Supplier | Unable to process this request Work Request is not active. Work Request is in <state> Response code. |
| 02022 | Request and Provide Additional Information | Response - exception | Work Supplier | Unable to process this request. Activity request or work request does not exist. |
| 02023 | Request and Provide Additional Information | Response - exception | Work Supplier | Unable to process this request. Task does not exist. |
| 02024 | Request and Provide Additional Information | Response - exception | Work Supplier | Unable to process this request. Activity request or work request does not exist. |
| 02025 | Request and Provide Additional Information | Response - exception | Work Supplier | Unable to process this request. Work Request is closed/cancelled. |
| 02026 | Request and Provide Additional Information | Response - exception | Work Supplier | Unable to process this request. Activity request is not in an open state. |
| 02042 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unavailable at this time. Try again later, or contact IT support team to investigate the issue. |
| 02043 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | Supplied TaskId does not exist. |
| 02044 | View and Query Field Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unable to share this information because requester does not have rights to GET this taskId. |
| 02045 | View & Query Work Request and Activity | Response - exception | Work Requestor or Work Supplier | WRM is unable to share this information because requester does not have rights to GET this taskId. |
| 010122 | All Use Cases | Response (work requestor did not create the work request) | Work Requestor | Permission to update the field work request and/or activity denied. Unable to update work request/activity. |
| 010123 | All Use Cases | Response (work request is not allocated to and accepted by the work supplier; except for accept/reject where the work request is not allocated to the work supplier) | Work Supplier | Permission to update the field work request and/or activity denied. Unable to update work request/activity. |